<!DOCTYPE HTML>

<html lang="en">
<head>

<title>HstsHeaderWriter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="HstsHeaderWriter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="HstsHeaderWriter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.header.writers</a></div>
<h2 title="Class HstsHeaderWriter" class="title">Class HstsHeaderWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.header.writers.HstsHeaderWriter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../HeaderWriter.html" title="interface in org.springframework.security.web.header">HeaderWriter</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">HstsHeaderWriter</span>
extends java.lang.Object
implements <a href="../HeaderWriter.html" title="interface in org.springframework.security.web.header">HeaderWriter</a></pre>
<div class="block">Provides support for <a href="https://tools.ietf.org/html/rfc6797">HTTP Strict
Transport Security (HSTS)</a>.
<p>
By default the expiration is one year, subdomains will be included and preload will not
be included. This can be customized using <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a>,
<a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a> and <a href="HstsHeaderWriter.html#setPreload(boolean)"><code>setPreload(boolean)</code></a> respectively.
</p>
<p>
Since <a href="https://tools.ietf.org/html/rfc6797#section-7.2">section 7.2</a> states
that HSTS Host MUST NOT include the STS header in HTTP responses, the default behavior
is that the "Strict-Transport-Security" will only be added when
<code>ServletRequest.isSecure()</code> returns <code>true</code> . At times this may need to
be customized. For example, in some situations where SSL termination is used, something
else may be used to determine if SSL was used. For these circumstances,
<a href="HstsHeaderWriter.html#setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)"><code>setRequestMatcher(RequestMatcher)</code></a> can be invoked with a custom
<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a>.
</p>
<p>
See <a href="https://hstspreload.org/">Website hstspreload.org</a> for additional
details on HSTS preload.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E()">HstsHeaderWriter</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(boolean)">HstsHeaderWriter</a></span>&#8203;(boolean&nbsp;includeSubDomains)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(long)">HstsHeaderWriter</a></span>&#8203;(long&nbsp;maxAgeInSeconds)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(long,boolean)">HstsHeaderWriter</a></span>&#8203;(long&nbsp;maxAgeInSeconds,
boolean&nbsp;includeSubDomains)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(long,boolean,boolean)">HstsHeaderWriter</a></span>&#8203;(long&nbsp;maxAgeInSeconds,
boolean&nbsp;includeSubDomains,
boolean&nbsp;preload)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(org.springframework.security.web.util.matcher.RequestMatcher,long,boolean)">HstsHeaderWriter</a></span>&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher,
long&nbsp;maxAgeInSeconds,
boolean&nbsp;includeSubDomains)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#%3Cinit%3E(org.springframework.security.web.util.matcher.RequestMatcher,long,boolean,boolean)">HstsHeaderWriter</a></span>&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher,
long&nbsp;maxAgeInSeconds,
boolean&nbsp;includeSubDomains,
boolean&nbsp;preload)</code></th>
<td class="colLast">
<div class="block">Creates a new instance</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)">setIncludeSubDomains</a></span>&#8203;(boolean&nbsp;includeSubDomains)</code></th>
<td class="colLast">
<div class="block">
If true, subdomains should be considered HSTS Hosts too.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)">setMaxAgeInSeconds</a></span>&#8203;(long&nbsp;maxAgeInSeconds)</code></th>
<td class="colLast">
<div class="block">
Sets the value (in seconds) for the max-age directive of the
Strict-Transport-Security header.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#setPreload(boolean)">setPreload</a></span>&#8203;(boolean&nbsp;preload)</code></th>
<td class="colLast">
<div class="block">
If true, preload will be included in HSTS Header.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)">setRequestMatcher</a></span>&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher)</code></th>
<td class="colLast">
<div class="block">Sets the <a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a> used to determine if the
"Strict-Transport-Security" should be added.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="HstsHeaderWriter.html#writeHeaders(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">writeHeaders</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Create a <code>Header</code> instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.security.web.util.matcher.RequestMatcher,long,boolean,boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher,
                        long&nbsp;maxAgeInSeconds,
                        boolean&nbsp;includeSubDomains,
                        boolean&nbsp;preload)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestMatcher</code> - maps to <a href="HstsHeaderWriter.html#setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)"><code>setRequestMatcher(RequestMatcher)</code></a></dd>
<dd><code>maxAgeInSeconds</code> - maps to <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a></dd>
<dd><code>includeSubDomains</code> - maps to <a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a></dd>
<dd><code>preload</code> - maps to <a href="HstsHeaderWriter.html#setPreload(boolean)"><code>setPreload(boolean)</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2.0</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.web.util.matcher.RequestMatcher,long,boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher,
                        long&nbsp;maxAgeInSeconds,
                        boolean&nbsp;includeSubDomains)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestMatcher</code> - maps to <a href="HstsHeaderWriter.html#setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)"><code>setRequestMatcher(RequestMatcher)</code></a></dd>
<dd><code>maxAgeInSeconds</code> - maps to <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a></dd>
<dd><code>includeSubDomains</code> - maps to <a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(long,boolean,boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(long&nbsp;maxAgeInSeconds,
                        boolean&nbsp;includeSubDomains,
                        boolean&nbsp;preload)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxAgeInSeconds</code> - maps to <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a></dd>
<dd><code>includeSubDomains</code> - maps to <a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a></dd>
<dd><code>preload</code> - maps to <a href="HstsHeaderWriter.html#setPreload(boolean)"><code>setPreload(boolean)</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2.0</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(long,boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(long&nbsp;maxAgeInSeconds,
                        boolean&nbsp;includeSubDomains)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxAgeInSeconds</code> - maps to <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a></dd>
<dd><code>includeSubDomains</code> - maps to <a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(long)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(long&nbsp;maxAgeInSeconds)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxAgeInSeconds</code> - maps to <a href="HstsHeaderWriter.html#setMaxAgeInSeconds(long)"><code>setMaxAgeInSeconds(long)</code></a></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter&#8203;(boolean&nbsp;includeSubDomains)</pre>
<div class="block">Creates a new instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>includeSubDomains</code> - maps to <a href="HstsHeaderWriter.html#setIncludeSubDomains(boolean)"><code>setIncludeSubDomains(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HstsHeaderWriter</h4>
<pre>public&nbsp;HstsHeaderWriter()</pre>
<div class="block">Creates a new instance</div>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="writeHeaders(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>writeHeaders</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;writeHeaders&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                         javax.servlet.http.HttpServletResponse&nbsp;response)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../HeaderWriter.html#writeHeaders(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">HeaderWriter</a></code></span></div>
<div class="block">Create a <code>Header</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../HeaderWriter.html#writeHeaders(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">writeHeaders</a></code>&nbsp;in interface&nbsp;<code><a href="../HeaderWriter.html" title="interface in org.springframework.security.web.header">HeaderWriter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the request</dd>
<dd><code>response</code> - the response</dd>
</dl>
</li>
</ul>
<a id="setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRequestMatcher&#8203;(<a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>&nbsp;requestMatcher)</pre>
<div class="block">Sets the <a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a> used to determine if the
"Strict-Transport-Security" should be added. If true the header is added, else the
header is not added. By default the header is added when
<code>ServletRequest.isSecure()</code> returns true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestMatcher</code> - the <a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a> to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <a href="../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a> is null</dd>
</dl>
</li>
</ul>
<a id="setMaxAgeInSeconds(long)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxAgeInSeconds</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxAgeInSeconds&#8203;(long&nbsp;maxAgeInSeconds)</pre>
<div class="block"><p>
Sets the value (in seconds) for the max-age directive of the
Strict-Transport-Security header. The default is one year.
</p>
<p>
This instructs browsers how long to remember to keep this domain as a known HSTS
Host. See <a href="https://tools.ietf.org/html/rfc6797#section-6.1.1">Section
6.1.1</a> for additional details.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxAgeInSeconds</code> - the maximum amount of time (in seconds) to consider this
domain as a known HSTS Host.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if maxAgeInSeconds is negative</dd>
</dl>
</li>
</ul>
<a id="setIncludeSubDomains(boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeSubDomains</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIncludeSubDomains&#8203;(boolean&nbsp;includeSubDomains)</pre>
<div class="block"><p>
If true, subdomains should be considered HSTS Hosts too. The default is true.
</p>
<p>
See <a href="https://tools.ietf.org/html/rfc6797#section-6.1.2">Section 6.1.2</a>
for additional details.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>includeSubDomains</code> - true to include subdomains, else false</dd>
</dl>
</li>
</ul>
<a id="setPreload(boolean)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPreload</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPreload&#8203;(boolean&nbsp;preload)</pre>
<div class="block"><p>
If true, preload will be included in HSTS Header. The default is false.
</p>
<p>
See <a href="https://tools.ietf.org/html/rfc6797#section-6.1.2">Section 6.1.2</a>
for additional details.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preload</code> - true to include preload, else false</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="HstsHeaderWriter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="HstsHeaderWriter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040df879adb97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
